#+TITLE: GUI Examples Info
#+AUTHOR: Zelphir Kaltstahl
#+EMAIL: zelphirkaltstahl@posteo.de
#+STARTUP: content indent align inlineimages hideblocks entitiesplain nologdone nologreschedule nologredeadline nologrefile
#+TODO: TODO INPROGRESS | DONE
#+DATE: <2021-06-15 Di>
#+LANGUAGE: English
#+PRIORITIES: A E E

* About

The examples are mostly taken from [[https://spk121.github.io/guile-gi/Tutorial.html]] or adapted from the examples there.

* Activate environment

#+begin_src shell
bash guix-env/env.sh
#+end_src

* Generating docs

One can invoke a command to generate docs for GLib as follows:

#+begin_src shell
guild gi-gtkdoc --format=html --output=docs --namespace=GLib --version=2.0
#+end_src

This will create a directory named =docs=, as specified by the argument =--output=docs=. In that directory there should be an =index.html=, which one can open in a browser. On that page, there should be a link labeled =Functions=. Clicking that link will direct to a page, which describes some functions.

* Other helpful documentation

+ Tutorial for =guile-gi=: [[https://spk121.github.io/guile-gi/Tutorial.html]]
  + Example repository: [[https://spk121.github.io/guile-gi/Window-with-Button.html]]
+ GTK docs: [[https://docs.gtk.org/gtk3/index.html]]
+ GI Repository docs: [[https://spk121.github.io/guile-gi/Typelib-Introspection.html]]
